Add a man page for gtk-encode-symbolic-svg
authorMatthias Clasen <mclasen@redhat.com>
Sun, 3 Aug 2014 00:45:16 +0000 (02:45 +0200)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 3 Aug 2014 00:45:16 +0000 (02:45 +0200)
docs/reference/gtk/Makefile.am
docs/reference/gtk/gtk-docs.sgml
docs/reference/gtk/gtk-encode-symbolic-svg.xml [new file with mode: 0644]

index db7c693169531bda41dbf0b23313c4297d07d489..f0eeabb7dbdfdac2837ca3a63f6f343ab2428c45 100644 (file)
@@ -156,6 +156,7 @@ content_files =                                     \
        gtk3-icon-browser.xml                   \
        gtk-query-immodules-3.0.xml             \
        gtk-update-icon-cache.xml               \
+       gtk-encode-symbolic-svg.xml             \
        gtk-launch.xml                          \
        broadwayd.xml                           \
        input-handling.xml                      \
@@ -333,6 +334,7 @@ EXTRA_DIST += version.xml.in gtk3.types.in
 man_MANS =                             \
        gtk-query-immodules-3.0.1       \
        gtk-update-icon-cache.1         \
+       gtk-encode-symbolic-svg.1       \
        gtk-launch.1                    \
        gtk3-demo.1                     \
        gtk3-widget-factory.1           \
index fbdf39143bae4679c8821944dec9acd9b58a9a0e..446d8725fb57ef6236db4934d73b8f912a6da45e 100644 (file)
     <xi:include href="gtk3-icon-browser.xml" />
     <xi:include href="gtk-query-immodules-3.0.xml" />
     <xi:include href="gtk-update-icon-cache.xml" />
+    <xi:include href="gtk-encode-symbolic-svg.xml" />
     <xi:include href="gtk-launch.xml" />
     <xi:include href="broadwayd.xml" />
   </part>
diff --git a/docs/reference/gtk/gtk-encode-symbolic-svg.xml b/docs/reference/gtk/gtk-encode-symbolic-svg.xml
new file mode 100644 (file)
index 0000000..f17e95d
--- /dev/null
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="gtk-encode-symbolic-svg">
+
+<refentryinfo>
+  <title>gtk-encode-symbolic-svg</title>
+  <productname>GTK+</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>gtk-encode-symbolic-svg</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>gtk-encode-symbolic-svg</refname>
+  <refpurpose>Symbolic icon conversion utility</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>gtk-encode-symbolic-svg</command>
+<arg choice="opt">OPTION...</arg>
+<arg choice="plain"><replaceable>PATH</replaceable></arg>
+<arg choice="plain"><replaceable>WIDTH</replaceable>x<replaceable>HEIGHT</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+  <command>gtk-encode-symbolic-svg</command> converts symbolic svg icons into
+  specially prepared png files. GTK+ can load and recolor these pngs, just like
+  original svgs, but loading them is much faster.
+</para>
+<para>
+  <replaceable>PATH</replaceable> is the name of a symbolic svg file,
+  <replaceable>WIDTH</replaceable>x<replaceable>HEIGHT</replaceable> are the
+  desired dimensions for the generated png file.
+</para>
+<para>
+  To distinguish them from ordinary pngs, the generated files have the extension
+  <filename>.symbolic.png</filename>.
+</para>
+</refsect1>
+
+<refsect1><title>Options</title>
+<variablelist>
+  <varlistentry>
+    <term>-o <replaceable>DIRECTORY</replaceable></term>
+    <term>--output <replaceable>DIRECTORY</replaceable></term>
+    <listitem><para>Write png files to <replaceable>DIRECTORY</replaceable>
+         instead of the current working directory.</para></listitem>
+  </varlistentry>
+</variablelist>
+</refsect1>
+
+</refentry>